home *** CD-ROM | disk | FTP | other *** search
/ JCSM Shareware Collection 1993 November / JCSM Shareware Collection - 1993-11.iso / cl040 / bbase19.lzh / BBSBASE.DOC next >
Encoding:
Text File  |  1990-09-16  |  6.4 KB  |  154 lines
  1. BBS-Base - Version 1.9c
  2. Copyright 1989 by John Parlin
  3. All Rights Reserved
  4.  
  5.  
  6. Licesning Information
  7. ---------------------
  8.  
  9. This program is freeware.  It is FREE of charge.  You may copy and distribute
  10. this program freely as long as the distribution files are not modified.
  11.  
  12.  
  13. Introduction
  14. ------------
  15.  
  16. BBS-Base is an online BBS list utility for RA and QuickBBS.  It allows users
  17. to enter BBSs in the database.  It provides for entry of private and public
  18. systems, creates an ASCII text file list (BBS.LST) suitable for online
  19. viewing or downloading.  BBS-Base can be used to maintain area BBS lists.
  20. In fact, that's the reason I wrote it in the first place; to maintain
  21. a valid list of BBSs to display on my board and to make available to
  22. users who wish to download it, and to keep a list of all visiting
  23. Sysop's BBS names/numbers.
  24.  
  25. BBS-Base does not list private entries in the BBS.LST file.  The reason
  26. that private BBSs are allowed is so that the Sysop can have a listing of
  27. say, another Sysop who runs a private system but wishes to leave the number
  28. for the Sysop.  It is policy on my board that visiting Sysops enter their
  29. system information in BBS-Base so that I can verify them on their system.
  30.  
  31. On the other hand, private entries do show up in the <L>ong listing but
  32. they are visible only to the person who created the entry and the Sysop
  33. as defined in the DORINFO1.DEF file.
  34.  
  35.  
  36. Installation
  37. ------------
  38.  
  39. BBS-Base is best called from a type 7 menu entry.  If you're running it
  40. from your QuickBBS home directory, simply create a type 7 menu entry with
  41. an optional data field consisting of:
  42.  
  43.                                 BBS-Base.Exe
  44.  
  45. That's all there is to it.  For those of you running your doors from
  46. other directories, well, you've gotten yourself this far so you obviously
  47. know what you're doing.  Knock yourselves out.
  48.  
  49. BBS-Base does take some command line parameters.  They are:
  50.  
  51.  /H - Brings up the help screen explaining the rest of the parameters.
  52.  /C - Converts a local text file BBS list to BBS-Base database format.
  53.  /S - Runs the sort routine only.
  54.  /R - Runs the report routine only.
  55.  /D - Allows any user to delete entries within the database.
  56.  /E - Allows any user to edit entries within the database.
  57.  /I - Prompts for phone numbers in international (free) format.
  58.  
  59. If any of the parameters above (with exception to the /D, /E and /I parameters)
  60. are found on the command line, BBS-Base will NOT come up in online mode.
  61. These are "manual" operation parameters.  If, for whatever reason, you decided
  62. you wanted to sort the database and generate a new BBS.LST report, you could
  63. simply enter the command:
  64.  
  65.                                 BBS-Base /S /R
  66.  
  67. When the sort and report routines are finished, the program will terminate.
  68.  
  69. Whenever an entry is added or changed, the database is resorted, rewritten and
  70. a new BBS.LST file written.  BBS.LST is an ASCII text file that can be viewed
  71. with type 5 and 45 menu entries or however else you'd want to display it and
  72. is also used for the short listing within the program.
  73.  
  74. Converting a Local BBS List
  75. ---------------------------
  76.  
  77. BBS-Base will now allow you to import a local BBS list to BBS-Base format.
  78. Within the distribution archive, you will find a file called BBSCVT.CFG.  This
  79. file contains a list of values to be used by BBS-Base for conversion purposes.
  80. The default values contained in the BBSCVT.CFG file are those used to convert
  81. the Twin Cities area ALLBBS list compiled by Terry Jorgenson.
  82.  
  83. Here are a couple of sample entries from an ALLBBS list:
  84.  
  85. C Station            452-5384 3/24  24     Opus       IBM     Steve Ripley   U
  86. City Terminal        938-4301 3/24  24     RA         IBM     John Parlin    U
  87.  
  88. And here is the default BBSCVT.CFG file:
  89.  
  90. 1,21            BBSName start, length
  91. 22,8            Phone start, length
  92. 31,5            Baud rates start, length (format min_baud/max_baud: 3/24, etc)
  93. 37,6            Hours (if = 24 then Fulltime else Parttime)
  94. 44,11           Software name start, length (if = QBBS then := QuickBBS)
  95. 63,15           Sysop name start, length
  96.  
  97. So what the BBSCVT.CFG file values tell us here is this:
  98.  
  99. The BBS name starts at column 1 and is 21 characters long.  This copies the
  100. contents from column 1 for 21 characters (till just before the first digit of
  101. the phone number).
  102.  
  103. The Phone number starts at column 22 and goes for 8 characters.
  104.  
  105. The Baud Rate field starts at column 31 and goes for 5 characters.
  106.  
  107. The Hours field starts at column 37 and goes for 6 characters.
  108.  
  109. The Software name starts at column 44 and goes for 11 characters.
  110.  
  111. The Sysop name starts at column 63 and goes for 15 characters.
  112.  
  113. NOTE:  The field lengths in BBS-Base are fixed so you should not expect to
  114.        copy a 20-character field into a 15-character field in BBS-Base.
  115.  
  116.        The BBS-Base field lengths used in conversion are:
  117.  
  118.            Field Name          Length
  119.            --------------      ------
  120.            BBS Name            20
  121.            Sysop Name          20
  122.            BBS Phone           14
  123.            BBS Hours           5
  124.            Software            10
  125.  
  126.        IMPORTANT: The field 'BBS Phone' must not contain an area code!  You
  127.                   will be prompted for the list's area code during conversion
  128.                   and it will be appended.  Also, lines not to be converted
  129.                   MUST BE REMOVED from the local list prior to conversion.
  130.                   There should be no blank lines in the BBS list.
  131.  
  132. As you can see, if you have a local BBS list you would like to convert, it may
  133. take some editing.  But if the list is a large one you will save yourself tons
  134. of time editing it with a text editor and then converting.  Rather that than
  135. to have to manually enter each entry.
  136.  
  137.  
  138. Support Files
  139. -------------
  140.  
  141. BBSBASE.DAT is the database file created and used by this program.
  142. BBSCVT.CFG is the database conversion parameter file.
  143. BBS.LST is the ASCII text file columnarized report file used by this program.
  144.  
  145. As always, if you have any questions, comments, or problems with this
  146. program, feel free to netmail a message to me.
  147.  
  148.                                         John Parlin
  149.                                         City Terminal BBS
  150.                                         (612) 938-4301
  151.                                         Twin Cities Metronet
  152.                                         Fidonet 1:282/12.0
  153.  
  154.